Error Codes

Inside Macintosh: OpenDoc Class Reference / Part 2 - Types and Constants

Error Codes
This section describes the constants defined for the ODError type (page 878).
The following error codes represent the exceptions that can be raised when you call an OpenDoc method. Error codes marked [M] are specific to the Mac OS platform.

kODErrAllVolumesAreFull
Failure to create a new document because there is not enough disk space available.
kODErrAlreadyImportedLink
Failure to create a link due to an internal error.
kODErrAlreadyNotified
An error occurred and the user has already been notified about it.
kODErrBackgroundClipboardClear
Attempt to clear the clipboard in a background process.
kODErrBrokenLink
Internal error; the link source disconnected from its destinations.
kODErrBrokenLinkSource
The link has been broken at the source.
kODErrCannotAcquireFrame
Failure to re-create the frame object from the specified storage unit.
kODErrCannotAcquireLink
Failure to re-create the link source or link object from the specified storage unit or link-specification object.
kODErrCannotAcquirePart
Failure to re-create the part object from the specified storage unit.
kODErrCannotAddAction
Attempt to add an action to the undo stack while another undo or redo operation was in progress.
kODErrCannotAddProperty
Unable to add the given property to a storage unit.
kODErrCannotAllocateDragItem
The drag-and-drop object cannot allocate storage for the item to be dragged.
kODErrCannotChangePermissions
Attempt to change permissions of a draft that has already been retrieved with different permissions.
kODErrCannotCollapseDrafts
Attempt to collapse drafts specified by an invalid range of drafts.
kODErrCannotCreateContainer
Failure to create a container because its specified type is not valid.
kODErrCannotCreateFrame
Failure to create the requested frame.
kODErrCannotCreateLink
Failure to create the requested link source or its companion link object.
kODErrCannotCreatePart
Failure to create the requested part object.
kODErrCannotCreateWindow
The window-state object cannot create a window.
kODErrCannotEmbed
Attempt to access embedded frames for a part that does not support embedding.
kODErrCannotEstablishLink
A persistent link could not be established.
kODErrCannotFindLinkSource
Failure to locate the source of a cross-document link.
kODErrCannotFindLinkSourceEdition [M]
Failure to locate the source of a cross-document link because the edition file does not exist.
kODErrCannotGetExternalLink [M]
The link manager cannot create the specified cross-document link because the process that created the link specification is no longer running.
kODErrCannotMarkAction
Failure to start an action subhistory by placing a mark at the beginning of the undo and redo stacks; the undo object was never initialized properly.
kODErrCannotOpenContainer
Failure to open the physical container.
kODErrCannotRegisterDependent
A link object cannot register a dependent at this time.
kODErrCannotRevealLink [M]
The source of a cross-document link cannot be shown because the link has been broken at the source.
kODErrCantCountFromLists
Attempt to count items in a container that is not a list.
kODErrCanvasHasNoOwner
The specified canvas has no owning part.
kODErrCanvasNotFound
The specified canvas does not exist.
kODErrCloningInProgress
Attempt to begin a cloning transaction while another cloning transaction is in progress for the same draft.
kODErrContainerDoesNotExist
Failure to get a container object because no container exists with the specified identifier.
kODErrContainerExists
Failure to create a container object because a container with the specified identifier already exists.
kODErrCorruptLink
Internal error; a link object cannot be created from persistent storage because the data is not in a recognized format.
kODErrCorruptLinkSource
Internal error; a link-source object cannot be created from persistent storage because the data is not in a recognized format.
kODErrCorruptLinkSpecValue
The focused storage unit contains an invalid link-specification value.
kODErrDirectoryNotHaveWriteAccess
Failure to move or copy the dragged item because you do not have write permission at the destination.
kODErrDocNotSaved [M]
Internal error; the link manager could not create a cross-document link.
kODErrDocumentDoesNotExist
Failure to get a document object because no document exists with the specified identifier.
kODErrDoesNotDrop
This part does not support drag and drop.
kODErrDoesNotLink
This part does not support linking.
kODErrDoesNotUndo
This part does not support undo/redo.
kODErrDraftDoesNotExist
Failure to get a draft object because no draft exists with the specified identifier.
kODErrDraftHasBeenDeleted
Attempt to operate on a draft that has been deleted.
kODErrDragItemNotFound
The drag-and-drop object cannot find the item to be dragged.
kODErrDragTrackingException
An exception occurred in the systemwide mouse tracking service.
kODErrEmptyStack
The undo or redo stack is empty; the undo object was never initialized properly.
kODErrFacetNotFound
The requested facet was not found.
kODErrFatalContainerError
A fatal error occurred in the container suite. This error must be propagated.
kODErrFocusAlreadyRegistered
The specified focus has already been registered.
kODErrFocusNotRegistered
A requested focus is not registered.
kODErrFrameHasFacets
The specified frame still has attached facets.
kODErrIllegalClipboardCloneKind
One of the methods ActionDone, ActionUndone, or ActionRedone of the clipboard object is called with a clone kind other than kODCloneCopy, kODCloneCut, or kODClonePaste.
kODErrIllegalNonTopmostDraft
The specified draft is not the topmost (most recent) draft of the document.
kODErrIllegalNullContainerInput
A method was passed null for a container parameter that cannot be null.
kODErrIllegalNullDispatchModuleInput
A dispatcher method was passed null for the dispatcher module.
kODErrIllegalNullDocumentInput
A method was passed null for a document parameter that cannot be null.
kODErrIllegalNullDraftInput
A method was passed null for a draft parameter that cannot be null.
kODErrIllegalNullFacetInput
A frame method was passed null for a facet parameter that cannot be null.
kODErrIllegalNullFrameInput
A frame method was passed null for a frame parameter that cannot be null.
kODErrIllegalNullIDInput
A method was passed null for an ID parameter that cannot be null.
kODErrIllegalNullInput
A method was passed null for a parameter that cannot be null.
kODErrIllegalNullPartInput
A frame method was passed null for a part parameter that cannot be null.
kODErrIllegalNullPropertyInput
A storage-unit method was passed null for a property parameter that cannot be null.
kODErrIllegalNullShapeInput
A frame method was passed null for a shape parameter that cannot be null.
kODErrIllegalNullStorageSystemInput
A frame method was passed null for the storage system parameter, which cannot be null.
kODErrIllegalNullStorageUnitInput
A method was passed null for a storage unit parameter that cannot be null.
kODErrIllegalNullSUCursorInput
A storage-unit method was passed null for a storage-unit cursor parameter that cannot be null.
kODErrIllegalNullTokenInput
A frame method was passed null for a token parameter that cannot be null.
kODErrIllegalNullTransformInput
A frame method was passed null for a transform parameter that cannot be null.
kODErrIllegalNullValueTypeInput
A frame method was passed null for a value type parameter that cannot be null.
kODErrIllegalOperationOnSU
The requested operation cannot be performed on the specified storage unit.
kODErrIllegalPropertyName
The specified property name is improperly formed or illegal.
kODErrIllegalRecursiveEmbedding
Attempt to embed a frame in its own part or in a containing part of its part.
kODErrInconsistentCloneKind
The specified clone kind is used inconsistently. For example, a paste or drop clone kind can occur only following a copy or cut operation.
kODErrInsufficientInfoInParams
The specified parameters to the method or function do not supply sufficient information, probably because all are null.
kODErrInvalidBelowDraft
Attempt to create a draft after (above) a draft that is not the most recent (top) draft of the document.
kODErrInvalidBlock
Attempt to access an invalid memory block, probably due to a bad heap or damaged object.
kODErrInvalidCloneKind
The specified clone kind is not valid.
kODErrInvalidCommandID [M]
No menu item exists with the specified command ID.
kODErrInvalidDestinationDraft
The specified destination draft is not valid for the specified clone kind.
kODErrInvalidDraftID
The specified draft ID is not valid in the context in which it is used.
kODErrInvalidDraftKey
The specified draft key is not the draft key for the current cloning transaction.
kODErrInvalidExtension
This extension object is invalid and should not be used because its base object no longer exists.
kODErrInvalidFacet
The specified facet is not valid in the context in which it is used; for example, it is not the child or parent of the facet whose method is being called.
kODErrInvalidFrame
The specified frame is not valid in the context in which it is used; for example, it is not a display frame of the part whose method is being called.
kODErrInvalidGraphicsSystem
This implementation of OpenDoc does not support the specified graphics system, that graphics system is not installed or available, or there is no drawing structure or print job associated with that graphics system.
kODErrInvalidID
The specified draft identifier is not valid in the context in which it is used.
kODErrInvalidIterator
The specified embedded-frames iterator is invalid and should not be used because the part that created it no longer exists.
kODErrInvalidITextFormat
The format of an ODIText structure (page 875) is not recognized.
kODErrInvalidLinkKey
The specified link key is not valid.
kODErrInvalidLinkStatus
The specified link status is not valid.
kODErrInvalidNSName
Failure to read a stored name space because the stored name does not match that of the name space being read.
kODErrInvalidNSType
The specified name space is of the wrong type (for example, it is a value name space but the method expects an object name space).
kODErrInvalidObjectType
The specified object type is not valid in the context in which it is used.
kODErrInvalidPermissions
The attempted action is not consistent with existing draft permissions.
kODErrInvalidPersistentFormat
Failure to read from persistent storage because the data is not in a recognized format.
kODErrInvalidPersistentObject
The specified persistent object is not valid.
kODErrInvalidPersistentObjectID
The specified identifier for a persistent object is not valid.
kODErrInvalidPlatformShape
The requested operation cannot be performed on the specified platform shape.
kODErrInvalidStorageUnit
The specified storage unit is not valid or the specified persistent object has no storage unit.
kODErrInvalidStorageUnitKey
Attempt to lock or unlock a storage unit with an invalid key.
kODErrInvalidStorageUnitRef
The specified persistent storage-unit reference is not valid.
kODErrInvalidValueType
The specified value type is improperly formed or illegal.
kODErrIteratorNotInitialized
A method was called on an uninitialized iterator.
kODErrIteratorOutOfSync
This iterator is invalid because its list was changed after the iterator was created.
kODErrKeyAlreadyExists
Failure to create a name-space object because a name space with the specified name already exists.
kODErrLinkAlreadyExported [M]
Internal error; the link manager cannot create a cross-document link because the specified link has already been exported.
kODErrMoveIntoSelf
A clone operation attempted to move a part into one of its embedded frames or embed one of the part's display frames into another of its display frames.
kODErrNoBeginAction
The undo object cannot find the begin action for this end action.
kODErrNoDraftProperties
Failure to create the storage unit to store draft properties.
kODErrNoDragManager
No platform-specific drag system service is available.
kODErrNoDragSystemStorage
The drag-and-drop object does not have system storage.
kODErrNoEditionManager [M]
The edition manager is not installed.
kODErrNoLinkContent
The link content storage unit has no contents property.
kODErrNoLinkSpecValue
The focused property does not contain a link-specification value.
kODErrNonEmptyDraft
Attempt to collapse nonempty drafts of a document.
kODErrNoPreviousDraft
Attempt to obtain the previous draft for the base draft of a document.
kODErrNoPromises
This part does not fulfill promises.
kODErrNoShapeGeometry
A shape that is being used as a polygon lacks geometric information (its polygonal representation).
kODErrNoSysTranslationFacility
No platform or system translation facility is installed. For example, this error will be thrown if Mac Easy Open is not installed on the Mac OS platform.
kODErrNotAnODToken
The specified token is not an OpenDoc token.
kODErrNotExportedLink [M]
Internal error; the specified link is not exported.
kODErrNotImplemented
The called method has not been implemented.
kODErrNotImportedLink [M]
Internal error; the link source is not imported.
kODErrNotRootFrame
This frame is not the root frame.
kODErrNoValueAtThatIndex
Failure to focus a storage unit because there is no value at the specified index.
kODErrNullDestinationFrame
The parameter specifying the destination frame is null.
kODErrNullFacetInput
A data-transfer method was passed null for a facet parameter that cannot be null.
kODErrNullLinkInfoInput
A data-transfer method was passed null for an ODLinkInfo parameter (page 923) that cannot be null.
kODErrNullLinkInfoResultInput
A data-transfer method was passed null for an ODLinkInfoResult parameter (page 924) that cannot be null.
kODErrNullPasteAsResultInput
A data-transfer method was passed null for a ODPasteAsResult parameter (page 918) that cannot be null.
kODErrObjectNotInitialized
An object has not been initialized properly.
kODErrOutOfMemory
Not enough memory to perform the specified operation (which involves an allocation).
kODErrOutstandingDraft
The attempted action would invalidate an outstanding draft (that is, one that is currently being referenced by some object).
kODErrPartInUse
The part for a specified wrapper is currently in use.
kODErrPartNotWrapper
A method was called on a part object instead of its encapsulating part wrapper.
kODErrPropertyDoesNotExist
The specified storage unit does not have the specified property.
kODErrRefCountGreaterThanZero
Attempt to delete a reference-counted object while it is being used (so its reference count is greater than 0).
kODErrRefCountNotEqualOne
Attempt to delete a global reference-counted object while it is being used. (When a global object is not being used, only the session object has a reference to it, so its reference count is 1.)
kODErrStorageUnitNotLocked
Attempt to unlock a storage unit that is not locked.
kODErrSubClassResponsibility
The called method should have been, but was not, overridden by the subclass of the class that defines the method.
kODErrSUValueDoesNotExist
The specified storage-unit value does not exist.
kODErrTransformErr
Attempt to perform an illegal operation on a transform object.
kODErrUndefined
An undefined error occurred.
kODErrUnfocusedStorageUnit
Attempt to perform an operation on a storage unit that is not properly focused.
kODErrUnknownDragImageType
The drag-and-drop object does not recognize the specified drag-image type.
kODErrUnknownExtension
The specified extension is not a known extension.
kODErrUnknownLinkSpecVersion [M]
The version of the link specifier is unknown.
kODErrUnknownUpdateID
The specified update ID is the reserved value kODUnknownUpdate.
kODErrUnsupportedExtension
Failure to get an object's extension because the object does not support the specified extension.
kODErrUnsupportedFramePositionCode
The frame position code specified for a new facet is not recognized.
kODErrUnsupportedPosCode
The specified position code is not supported in the context in which it is used.
kODErrValueIndexOutOfRange
The specified property has no value at the specified index.
kODErrValueOutOfRange
A numeric value does not fall within the correct range of values.
kODErrVolumeIsFull
Failure to move or copy the dragged item because there is not enough disk space on that volume.
kODErrZeroRefCount
Attempt to decrement an object's reference count that is already 0.

The following additional constants of type ODError (page 878) do not represent error conditions.

kODMaxError
The maximum numeric value for OpenDoc error codes.
kODMinError
The minimum numeric value for error OpenDoc codes.
kODMinUsedError
The minimum numeric value for error codes currently in use.
kODNoError
No error occurred.